<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: async_work_on_timeout Struct Reference</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.1.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structasync__work__on__timeout.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">async_work_on_timeout Struct Reference<div class="ingroups"><a class="el" href="group__high__level.html">High Level APIs</a> &raquo; <a class="el" href="group__pico__async__context.html">pico_async_context</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>A "timeout" instance used by an <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>.  
 <a href="structasync__work__on__timeout.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="async__context_8h_source.html">async_context.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for async_work_on_timeout:</div>
<div class="dyncontent">
<div class="center"><img src="structasync__work__on__timeout__coll__graph.png" border="0" usemap="#aasync__work__on__timeout_coll__map" alt="Collaboration graph"/></div>
<map name="aasync__work__on__timeout_coll__map" id="aasync__work__on__timeout_coll__map">
<area shape="rect" title="A &quot;timeout&quot; instance used by an async_context." alt="" coords="5,5,185,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a0d624915407b8a4c38d0bc8b2e097729"><td class="memItemLeft" align="right" valign="top"><a id="a0d624915407b8a4c38d0bc8b2e097729" name="a0d624915407b8a4c38d0bc8b2e097729"></a>
struct <a class="el" href="structasync__work__on__timeout.html">async_work_on_timeout</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>next</b></td></tr>
<tr class="memdesc:a0d624915407b8a4c38d0bc8b2e097729"><td class="mdescLeft">&#160;</td><td class="mdescRight">private link list pointer <br /></td></tr>
<tr class="separator:a0d624915407b8a4c38d0bc8b2e097729"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01235aef0d013ca28c820df4809c505b"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structasync__work__on__timeout.html#a01235aef0d013ca28c820df4809c505b">do_work</a> )(<a class="el" href="structasync__context.html">async_context_t</a> *context, struct <a class="el" href="structasync__work__on__timeout.html">async_work_on_timeout</a> *timeout)</td></tr>
<tr class="memdesc:a01235aef0d013ca28c820df4809c505b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method called when the timeout is reached; may not be NULL.  <a href="structasync__work__on__timeout.html#a01235aef0d013ca28c820df4809c505b">More...</a><br /></td></tr>
<tr class="separator:a01235aef0d013ca28c820df4809c505b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a695beb1e493cb6c2b15f0907e9a2cfb4"><td class="memItemLeft" align="right" valign="top"><a id="a695beb1e493cb6c2b15f0907e9a2cfb4" name="a695beb1e493cb6c2b15f0907e9a2cfb4"></a>
<a class="el" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>next_time</b></td></tr>
<tr class="memdesc:a695beb1e493cb6c2b15f0907e9a2cfb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The next timeout time; this should only be modified during the above methods or via <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a> methods. <br /></td></tr>
<tr class="separator:a695beb1e493cb6c2b15f0907e9a2cfb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa3132dfb1f9a29b4e3feae105da4b59"><td class="memItemLeft" align="right" valign="top"><a id="aaa3132dfb1f9a29b4e3feae105da4b59" name="aaa3132dfb1f9a29b4e3feae105da4b59"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>user_data</b></td></tr>
<tr class="memdesc:aaa3132dfb1f9a29b4e3feae105da4b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data associated with the timeout instance. <br /></td></tr>
<tr class="separator:aaa3132dfb1f9a29b4e3feae105da4b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A "timeout" instance used by an <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>. </p>
<p >A "timeout" represents some future action that must be taken at a specific time. Its methods are called from the <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a> under lock at the given time</p>
<dl class="section see"><dt>See also</dt><dd>async_context_add_worker_at </dd>
<dd>
async_context_add_worker_in_ms </dd></dl>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a01235aef0d013ca28c820df4809c505b" name="a01235aef0d013ca28c820df4809c505b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01235aef0d013ca28c820df4809c505b">&#9670;&nbsp;</a></span>do_work</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* async_work_on_timeout::do_work) (<a class="el" href="structasync__context.html">async_context_t</a> *context, struct <a class="el" href="structasync__work__on__timeout.html">async_work_on_timeout</a> *timeout)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Method called when the timeout is reached; may not be NULL. </p>
<p >Note, that when this method is called, the timeout has been removed from the <a class="el" href="structasync__context.html" title="Base structure type of all async_contexts. For details about its use, see pico_async_context.">async_context</a>, so if you want the timeout to repeat, you should re-add it during this callback </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td></td></tr>
    <tr><td class="paramname">timeout</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/pico/<a class="el" href="async__context_8h_source.html">async_context.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>